home *** CD-ROM | disk | FTP | other *** search
/ Aminet 33 / Aminet 33 - October 1999.iso / Aminet / util / cli / JustComm.lha / justifycomment / JustComm.doc next >
Encoding:
Text File  |  1999-08-06  |  6.1 KB  |  174 lines
  1. NAME
  2.    JustComm v1.0 - CLI based utility to make filenotes look better.
  3.                    (JustComm is a shortage for justify comment.)
  4.   
  5.  
  6. FEATURES
  7.    * Convert letters to uppercase or lowercase
  8.    * Make 1st. letter uppercase
  9.    * Make short for copyright '(c)' uppercase
  10.    * Make roman numbers uppercase (ex: xvIi -> XVII)
  11.    * Remove CTRL-characters. These are characters which are
  12.      displayed as strange and meaningless characters, like 
  13.      f.ex squares.
  14.    * Convert only the substrings which matches a string given 
  15.      by the user.
  16.    * Make 1st. letter after a character uppercase. The user
  17.      can specify one or more such characters. 
  18.  
  19.  
  20. USAGE
  21.    JustComm [-<options>] [<advanced options>] "<filename>"
  22.  
  23.    Options:
  24.    --------
  25.     u         Make letters uppercase
  26.     l         Make letters lowercase
  27.     1         Make 1st. letter uppercase.
  28.     c         Make short for copyright '(c)' uppercase
  29.     r         Make roman numbers uppercase. 
  30.               These are the letters M,D,C,L,X,V,I.
  31.     t         Remove CTRL-characters.
  32.     n         Use Norwegian character set
  33.     e         Use English character set (this is default)
  34.  
  35.     NOTE: The options are CASE SENSITIVE.
  36.           The USAGE will be displayed when typing JustComm without
  37.           arguments, or when an error occurs.
  38.           You can specify one or more options after a single '-',
  39.           and as many '-' as you like, as long as a <blank> is
  40.           placed in front of each '-'.
  41.  
  42.           Example: Convert the filenote "**my oWn clI-coMmANd (c)1999"
  43.                                      to "**My own cli-command (C)1999"
  44.           To achieve this, use the options 1,l and c:
  45.           Example 1: -1 -l -c
  46.           Example 2: -1l -c
  47.           Example 3: -1lc
  48.  
  49.  
  50.    Advanced options:
  51.    -----------------
  52.     SEL="<string>"   Select only substrings which matches the given string.
  53.     FLU="<string>"   Make 1st. letter after one of the characters in
  54.                      the given string uppercase.
  55.  
  56.     NOTE: The advanced options and the strings are CASE INSENSITIVE.
  57.           No spaces are allowed either before or after the '='.
  58.         
  59.           Example: Convert the filenote "**my own cli-command (C)1999"
  60.                                      to "**My own cli-Command (C)1999"
  61.           To achieve this, use the following advanced options:
  62.           FLU="*-"
  63.  
  64.           If you in addition want to make the "cli"-text uppercase,
  65.           use the following combination of advanced options and options:
  66.  
  67.           SEL="cli" -u
  68.  
  69.           The filenote will now look like this:
  70.                                         "**My own CLI-Command (C)1999"
  71.    
  72.  
  73.    Filename(s):
  74.    ------------
  75.     One or more filenames can be chosen.
  76.     Each filename must be specified within quotes.
  77.     If you choose more than one filename, each file has to be specified
  78.     after each other. This means no options or advanced options 
  79.     between the filenames.
  80.     The utility doesn't support wildcards in filenames, but treats them
  81.     as if they are normal characters.
  82.  
  83.     Example: "RAM:file1" "RAM:file2" "RAM:file3"
  84.  
  85.  
  86.  
  87.    General:
  88.    --------
  89.     The options and advanced options can be placed whereever you like,
  90.     as long as they aren't placed between two filenames.
  91.     But remember: When using Directory Opus, you should always place
  92.                   the filenames last. Directory Opus seems to have
  93.                   a maximum argument length when running CLI-commands, 
  94.                   and when exceeding this limit, it splits the 
  95.                   argument-string and runs the CLI-command several times. 
  96.                   If the filenames are placed last, you ensure that 
  97.                   no option are moved to the next "splitted" 
  98.                   argument string.
  99.                     If you don't, unexpected results may occur, like
  100.                   these error messages: "missing args !", "wrong args !", 
  101.                   etc.
  102.  
  103.  
  104.  
  105.    A complete example:
  106.    -------------------
  107.     Suppose we have 2 files:
  108.      
  109.     Filename  Filenote
  110.     file1     a CoMPlEte TEST of the clicOmMaNd ! (c)1999 mr. lightstone 
  111.     file2     tHiS is a teSt of roman leTteRs: xvii, and ÆØÅ.
  112.  
  113.     We want them to look like this:
  114.     Filename  Filenote
  115.     file1     A complete test of the CLIcommand ! (C)1999 Mr. Lightstone 
  116.     file2     This is a test of roman letters: XVII, and ÆØÅ.
  117.  
  118.     Example 1:  JustComm -1lcr FLU="9." "file1" "file2"
  119.                 JustComm -u SEL="cli" "file1" "file2"
  120.  
  121.     If you also want to make the ÆØÅ lowercase, simply add -n to the
  122.     argument.
  123.  
  124.  
  125.  
  126. COMPATIBILITY
  127.     It has been testet from CLI and Directory Opus 4 on Amigas using 
  128.     standard filesystem:
  129.     * A500  / 0.5MB Fast / Kickstart 1.3
  130.     * A1200 / Blizzard 1230 / 32MB Fast / Kickstart 3.1 / 1.6 GB HD
  131.  
  132.     And the following one from Directory Opus 5. 
  133.     SmartFileSystem and ProFileSystem II where used as filesystems:
  134.     * A1200 / Blizzard 1230 / 40MB Fast / Kickstart 3.0 / 6.5 GB HD
  135.  
  136.  
  137.  
  138. DISCLAIMER
  139.     Copyright © 1999 by Mr. Lightstone.
  140.  
  141.     Use JustComm at your own risk. The author cannot be held responsible
  142.     for any damage that is directly or indirectly caused by the use of
  143.     this program.
  144.  
  145.     JustComm is freeware. This means it can be copied freely, as long as 
  146.     all files in this archive are kept unmodified.
  147.  
  148.     If you like it, have any comments or suggestions, just drop me an 
  149.     E-mail.
  150.  
  151.  
  152. CREDITS
  153.     Thanks to PER for the inquiry of such a CLI-command, and for the
  154.     suggestion of the -t option. 
  155.     Thanks to JEANO for the suggestion of the -c and -r options.
  156.  
  157.  
  158. -------------------------------------------------------------------------
  159.  
  160.  
  161.  
  162. ========================= Archive contents ==============================
  163.  
  164.  
  165. Listing of archive 'JustComm.lha':
  166. Original  Packed Ratio    Date     Time    Name
  167. -------- ------- ----- --------- --------  -------------
  168.     2884    2012 30.2% 29-Jul-99 14:33:06  justifycomment/JustComm
  169.     6208    2403 61.2% 06-Aug-99 01:18:30  justifycomment/JustComm.doc
  170.     1635     750 54.1% 06-Aug-99 01:09:06  justifycomment/JustComm.readme
  171. -------- ------- ----- --------- --------
  172.    10727    5165 51.8% 06-Aug-99 01:19:26   3 files
  173.  
  174. Operation successful.